NZPost.AddressChecker
Find Addresses
Resource URL
UAT:
http://api.uat.nzpost.co.nz/addresschecker/1.0/findhttps://api.nzpost.co.nz/addresschecker/1.0/findResource Description
Takes an address fragment, and returns a set of addresses that match the fragment.
Resource Information
| Attribute | Detail |
|---|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | 15 calls per second. If rate limit is exceeded, calls will be queued. Calls unprocessed for over 60 seconds will time out. |
Please note that all request parameters should be in lower case.
Request Parameters
| Field Name | Description | Value | Required | Example |
|---|---|---|---|---|
| address_line_1 | First line of address to query. | String | Yes | 8 waterloo quay |
| address_line_2 | Second line of address to query. | String | No | Pipitea |
| address_line_3 | Third line of address to query. | String | No | Wellington |
| address_line_4 | Fourth line of address to query. | String | No | |
| address_line_5 | Fifth line of address to query. | String | No | |
| max | Maximum number of results to return. (default: 10) | Integer | No | 5 |
Sample Request
https://api.nzpost.co.nz/addresschecker/1.0/find?address_line_1=8+waterloo+quay&address_line_2=Pipitea&max=2Response Parameters
| Field Name | Description | Value | Required | Example |
|---|---|---|---|---|
| success | Indicates if the request succeeded or not. | Boolean | Yes | true |
| addresses | Contains array of address objects. The number of objects will not exceed the 'max' value defined. | Array | Yes if success = true | See Address Object below |
| status | Status of the request. | String | Yes | success |
Addresses Object
| Field Name | Description | Value | Example |
|---|---|---|---|
| DPID | Unique NZ Post identifier. | Integer | 3499717 |
| Deliverable | Y/N. Indicates if the address has mail delivery. NOTE: A rural postal address is not valid if this flag = "N". | String | N |
| FullAddress | Full address format. | String | 8 Waterloo Quay, Pipitea, Wellington 6011 |
| MatchScore | Returns a score on how well the request parameters match the full address. | Integer | 95 |
| MatchedFloor .. MatchedUnit | Indicates whether the request parameters match the corresponding field. Returns "Y" if matches and "N" if does not match. |
String | Y |
| Physical | Indicates whether the full address is a physical address. Returns "Y" if address is physical address and "N" if not a physical address. |
String | Y |
| SourceDesc | Address Reference Dataset source category text. | String | Postal\\Physical |
Sample Response
